home *** CD-ROM | disk | FTP | other *** search
/ Workbench Add-On / Workbench Add-On - Volume 1.iso / Dev / Oberon / source / amiga / AmigaGuide.mod next >
Text File  |  1995-06-29  |  12KB  |  380 lines
  1. (**************************************************************************
  2.  
  3.      $RCSfile: AmigaGuide.mod $
  4.   Description: Interface to amigaguide.library
  5.  
  6.    Created by: fjc (Frank Copeland)
  7.     $Revision: 3.8 $
  8.       $Author: fjc $
  9.         $Date: 1995/06/04 23:13:14 $
  10.  
  11.   Includes Release 40.15
  12.  
  13.   (C) Copyright 1990-1993 Commodore-Amiga, Inc.
  14.       All Rights Reserved
  15.  
  16.   Oberon-A Interface Copyright © 1994-1995, Frank Copeland.
  17.   This file is part of the Oberon-A Interface.
  18.   See Oberon-A.doc for conditions of use and distribution.
  19.  
  20. *************************************************************************)
  21.  
  22. <* STANDARD- *>
  23.  
  24. MODULE [2] AmigaGuide;
  25.  
  26. IMPORT
  27.   SYS := SYSTEM, Kernel, e := Exec, u := Utility, d := Dos,
  28.   i := Intuition, s := Sets;
  29.  
  30.  
  31. TYPE
  32.  
  33. (**-- Pointer declarations ---------------------------------------------*)
  34.  
  35.   AmigaGuideMsgPtr * = POINTER TO AmigaGuideMsg;
  36.   ContextTablePtr * = POINTER TO ContextTable;
  37.   NewAmigaGuidePtr * = POINTER TO NewAmigaGuide;
  38.   XRefPtr * = POINTER TO XRef;
  39.   AmigaGuideHostPtr * = POINTER TO AmigaGuideHost;
  40.   OpFindHostPtr * = POINTER TO OpFindHost;
  41.   OpNodeIOPtr * = POINTER TO OpNodeIO;
  42.   OpExpungeNodePtr * = POINTER TO OpExpungeNode;
  43.  
  44.  
  45. (**-- Library definitions ----------------------------------------------*)
  46.  
  47. CONST
  48.  
  49.   apshToolId       * = 11000;
  50.   startupMsgId     * = apshToolId+1;  (* Startup message *)
  51.   loginToolId      * = apshToolId+2;  (* Login a tool SIPC port *)
  52.   logoutToolId     * = apshToolId+3;  (* Logout a tool SIPC port *)
  53.   shutdownMsgId    * = apshToolId+4;  (* Shutdown message *)
  54.   activateToolId   * = apshToolId+5;  (* Activate tool *)
  55.   deactivateToolId * = apshToolId+6;  (* Deactivate tool *)
  56.   activeToolId     * = apshToolId+7;  (* Tool Active *)
  57.   inactiveToolId   * = apshToolId+8;  (* Tool Inactive *)
  58.   toolStatusId     * = apshToolId+9;  (* Status message *)
  59.   toolCmdId        * = apshToolId+10; (* Tool command message *)
  60.   toolCmdReplyId   * = apshToolId+11; (* Reply to tool command *)
  61.   shutdownToolId   * = apshToolId+12; (* Shutdown tool *)
  62.  
  63. (* Attributes accepted by GetAmigaGuideAttr() *)
  64.   agaDummy      * = u.user;
  65.   path          * = agaDummy+1;
  66.   xrefList      * = agaDummy+2;
  67.   activate      * = agaDummy+3;
  68.   context       * = agaDummy+4;
  69.  
  70.   helpGroup     * = agaDummy+5;    (* e.ULONG: Unique identifier *)
  71.  
  72.   agaReserved1  * = agaDummy+6;
  73.   agaReserved2  * = agaDummy+7;
  74.   agaReserved3  * = agaDummy+8;
  75.  
  76.   aRexxPort     * = agaDummy+9;
  77.     (* e.MsgPortPtr: Pointer to the ARexx message port (V40) *)
  78.  
  79.   arexxPortName * = agaDummy+10;
  80.     (* e.LSTRPTR: Used to specify the ARexx port name (V40) (not copied) *)
  81.  
  82. TYPE
  83.  
  84.   AGContext * = POINTER TO RECORD END;
  85.  
  86.   AmigaGuideMsg * = RECORD (e.MessageBase)
  87.     msg     * : e.Message;             (* Embedded Exec message structure *)
  88.     type    * :  e.ULONG;              (* Type of message *)
  89.     data    * :  e.APTR;               (* Pointer to message data *)
  90.     dSize   * :  e.ULONG;              (* Size of message data *)
  91.     dType   * :  e.ULONG;              (* Type of message data *)
  92.     priRet  * :  e.ULONG;              (* Primary return value *)
  93.     secRet  * :  e.ULONG;              (* Secondary return value *)
  94.     system1 * :  e.APTR;
  95.     system2 * :  e.APTR;
  96.   END;
  97.  
  98. (* Allocation description structure *)
  99.  
  100.   ContextTable * = ARRAY MAX(INTEGER) OF e.LSTRPTR;
  101.  
  102.   NewAmigaGuide * = RECORD
  103.     lock       * : d.FileLockPtr; (* Lock on the document directory *)
  104.     name       * : e.LSTRPTR;     (* Name of document file *)
  105.     screen     * : i.ScreenPtr;   (* Screen to place windows within *)
  106.     pubScreen  * : e.LSTRPTR;     (* Public screen name to open on *)
  107.     hostPort   * : e.LSTRPTR;     (* Application's ARexx port name *)
  108.     clientPort * : e.LSTRPTR;     (* Name to assign to the clients ARexx port *)
  109.     baseName   * : e.LSTRPTR;     (* Base name of the application *)
  110.     flags      * : s.SET32;       (* Flags *)
  111.     context    * : ContextTablePtr; (* NULL terminated context table *)
  112.     node       * : e.LSTRPTR;     (* Node to align on first (defaults to Main) *)
  113.     line       * : LONGINT;       (* Line to align on *)
  114.     extens     * : u.TagListPtr;  (* Tag array extension *)
  115.     client     * : e.APTR;        (* Private! MUST be NULL *)
  116.   END;
  117.  
  118. CONST
  119.  
  120. (* public Client flags *)
  121.  
  122.   loadIndex  * = 0;  (* Force load the index at init time *)
  123.   loadAll    * = 1;  (* Force load the entire database at init *)
  124.   cacheNode  * = 2;  (* Cache each node as visited *)
  125.   cacheDB    * = 3;  (* Keep the buffers around until expunge *)
  126.   unique     * = 15; (* Unique ARexx port name *)
  127.   noActivate * = 16; (* Don't activate window *)
  128.  
  129.   sysGads    * = 31;
  130.  
  131. (* Callback function ID's *)
  132.   open  * = 0;
  133.   close * = 1;
  134.  
  135.   notEnoughMemory  * = 100;
  136.   cantOpenDatabase * = 101;
  137.   cantFindNode     * = 102;
  138.   cantOpenNode     * = 103;
  139.   cantOpenWindow   * = 104;
  140.   invalidCommand   * = 105;
  141.   cantComplete     * = 106;
  142.   portClosed       * = 107;
  143.   cantCreatePort   * = 108;
  144.   keywordNotFound  * = 113;
  145.  
  146. TYPE
  147.  
  148. (* Cross reference node *)
  149.   XRef * = RECORD (e.NodeBase)
  150.     node   * : e.Node;                 (* Embedded node *)
  151.     pad    * :  e.UWORD;               (* Padding *)
  152.     df     * :  e.APTR (*DocFilePtr*); (* Document defined in *)
  153.     file   * :  e.LSTRPTR;             (* Name of document file *)
  154.     name   * :  e.LSTRPTR;             (* Name of item *)
  155.     line   * :  LONGINT;               (* Line defined at *)
  156.   END;
  157.  
  158. CONST
  159.  
  160.   XRSize * = SIZE (XRef);
  161.  
  162. (* Types of cross reference nodes *)
  163.   generic  * = 0;
  164.   function * = 1;
  165.   command  * = 2;
  166.   include  * = 3;
  167.   macro    * = 4;
  168.   struct   * = 5;
  169.   field    * = 6;
  170.   typedef  * = 7;
  171.   define   * = 8;
  172.  
  173. TYPE
  174.  
  175. (* Callback handle *)
  176.  
  177.   AmigaGuideHost * = RECORD (u.HookBase)
  178.     dispatcher * : u.Hook;           (* Dispatcher *)
  179.     reserved   * :  e.ULONG;         (* Must be 0 *)
  180.     flags      * :  s.SET32;
  181.     useCnt     * :  e.ULONG;         (* Number of open nodes *)
  182.     systemData   :  e.APTR;          (* Reserved for system use *)
  183.     userData   * :  e.APTR;          (* Anything you want... *)
  184.   END;
  185.  
  186. CONST
  187.  
  188. (* Methods *)
  189.   findNode  * = 1;
  190.   openNode  * = 2;
  191.   closeNode * = 3;
  192.   expunge   * = 10;  (* Expunge DataBase *)
  193.  
  194. TYPE
  195.  
  196.   MethodBase *= RECORD END;
  197.   Method * = RECORD (MethodBase)
  198.     ID * : e.ULONG;
  199.   END;
  200.  
  201. (* hmFindnode *)
  202.   OpFindHost * = RECORD (MethodBase)
  203.     method * : Method;
  204.     attrs -  :  u.TagListPtr; (*  R: Additional attributes *)
  205.     node  -  :  e.LSTRPTR;    (*  R: Name of node *)
  206.     TOC   *  :  e.LSTRPTR;    (*  W: Table of Contents *)
  207.     title *  :  e.LSTRPTR;    (*  W: Title to give to the node *)
  208.     next  *  :  e.LSTRPTR;    (*  W: Next node to browse to *)
  209.     prev  *  :  e.LSTRPTR;    (*  W: Previous node to browse to *)
  210.   END;
  211.  
  212. (* hmOpennode, hmClosenode *)
  213.   OpNodeIO * = RECORD (MethodBase)
  214.     method    * : Method;
  215.     attrs     - : u.TagListPtr;  (*  R: Additional attributes *)
  216.     node      - : e.LSTRPTR;     (*  R: Node name and arguments *)
  217.     fileName  * : e.LSTRPTR;     (*  W: File name buffer *)
  218.     docBuffer * : e.LSTRPTR;     (*  W: Node buffer *)
  219.     buffLen   * : e.ULONG;       (*  W: Size of buffer *)
  220.     flags     * : s.SET32;       (* RW: Control flags *)
  221.   END;
  222.  
  223. CONST
  224.  
  225. (* OpNodeIO.flags *)
  226.   keep      * = 0;      (* Don't flush this node until database is
  227.                          * closed. *)
  228.   reserved1 * = 1;      (* Reserved for system use *)
  229.   reserved2 * = 2;      (* Reserved for system use *)
  230.   ascii     * = 3;      (* Node is straight ASCII *)
  231.   reserved3 * = 4;      (* Reserved for system use *)
  232.   clean     * = 5;      (* Remove the node from the database *)
  233.   done      * = 6;      (* Done with node *)
  234.  
  235. (* OpNodeIO.attrs *)
  236.   htnaDummy      * = u.user;
  237.   htnaScreen     * = htnaDummy+1;  (* i.ScreenPtr: Screen that window resides in *)
  238.   htnaPens       * = htnaDummy+2;  (* Pen array (from DrawInfo) *)
  239.   htnaRectangle  * = htnaDummy+3;  (* Window box *)
  240.  
  241.   htnaHelpGroup  * = htnaDummy+5;  (* e.ULONG: unique identifier *)
  242.  
  243. TYPE
  244.  
  245. (* hmExpunge *)
  246.   OpExpungeNode * = RECORD (MethodBase)
  247.     method * : Method;
  248.     attrs -  : u.TagListPtr;  (*  R: Additional attributes *)
  249.   END;
  250.  
  251. (**-- Library Base variable --------------------------------------------*)
  252.  
  253. CONST
  254.  
  255.   amigaguideName * = "amigaguide.library";
  256.  
  257. VAR
  258.  
  259.   base* : e.LibraryPtr;
  260.  
  261.  
  262. (**-- Library Functions ------------------------------------------------*)
  263.  
  264. (*--- functions in V40 or higher (Release 3.1) ---*)
  265.  
  266. (* Public entries *)
  267.  
  268. PROCEDURE LockAmigaGuideBase* [base,-36]
  269.   ( handle [8] : AGContext )
  270.   : LONGINT;
  271. PROCEDURE UnlockAmigaGuideBase* [base,-42]
  272.   ( key [0] : LONGINT );
  273. PROCEDURE OpenAmigaGuideA* [base,-54]
  274.   ( VAR nag [8] : NewAmigaGuide;
  275.     attrs   [9] : ARRAY OF u.TagItem )
  276.   : AGContext;
  277. PROCEDURE OpenAmigaGuide* [base,-54]
  278.   ( VAR nag [8]  : NewAmigaGuide;
  279.     attrs   [9]..: u.Tag )
  280.   : AGContext;
  281. PROCEDURE OpenAmigaGuideAsyncA* [base,-60]
  282.   ( VAR nag [8] : NewAmigaGuide;
  283.     attrs   [0] : ARRAY OF u.TagItem )
  284.   : AGContext;
  285. PROCEDURE OpenAmigaGuideAsync* [base,-60]
  286.   ( VAR nag [8]  : NewAmigaGuide;
  287.     attrs   [0]..: u.Tag )
  288.   : AGContext;
  289. PROCEDURE CloseAmigaGuide* [base,-66]
  290.   ( cl [8] : AGContext );
  291. PROCEDURE AmigaGuideSignal* [base,-72]
  292.   ( cl [8] : AGContext )
  293.   : e.ULONG;
  294. PROCEDURE GetAmigaGuideMsg* [base,-78]
  295.   ( cl [8] : AGContext )
  296.   : AmigaGuideMsgPtr;
  297. PROCEDURE ReplyAmigaGuideMsg* [base,-84]
  298.   ( amsg [8] : AmigaGuideMsgPtr );
  299. PROCEDURE SetAGContextA* [base,-90]
  300.   ( cl    [8] : AGContext;
  301.     id    [0] : e.ULONG;
  302.     attrs [1] : ARRAY OF u.TagItem )
  303.   : BOOLEAN;
  304. PROCEDURE SetAGContext* [base,-90]
  305.   ( cl    [8] : AGContext;
  306.     id    [0] : e.ULONG;
  307.     attrs [1] ..: u.Tag )
  308.   : BOOLEAN;
  309. PROCEDURE SendAGContextA* [base,-96]
  310.   ( cl    [8] : AGContext;
  311.     attrs [0] : ARRAY OF u.TagItem )
  312.   : BOOLEAN;
  313. PROCEDURE SendAGContext* [base,-96]
  314.   ( cl    [8]  : AGContext;
  315.     attrs [0]..: u.Tag )
  316.   : BOOLEAN;
  317. PROCEDURE SendAmigaGuideCmdA* [base,-102]
  318.   ( cl    [8] : AGContext;
  319.     cmd   [0] : ARRAY OF CHAR;
  320.     attrs [1] : ARRAY OF u.TagItem )
  321.   : BOOLEAN;
  322. PROCEDURE SendAmigaGuideCmd* [base,-102]
  323.   ( cl    [8]  : AGContext;
  324.     cmd   [0]  : ARRAY OF CHAR;
  325.     attrs [1]..: u.Tag )
  326.   : BOOLEAN;
  327. PROCEDURE SetAmigaGuideAttrsA* [base,-108]
  328.   ( cl    [8] : AGContext;
  329.     attrs [9] : ARRAY OF u.TagItem )
  330.   : LONGINT;
  331. PROCEDURE SetAmigaGuideAttrs* [base,-108]
  332.   ( cl    [8]  : AGContext;
  333.     attrs [9]..: u.Tag )
  334.   : LONGINT;
  335. PROCEDURE GetAmigaGuideAttr* [base,-114]
  336.   ( tag         [0] : u.Tag;
  337.     cl          [8] : AGContext;
  338.     VAR storage [9] : e.APTR )
  339.   : LONGINT;
  340. PROCEDURE LoadXRef* [base,-126]
  341.   ( lock [8] : d.FileLockPtr;
  342.     name [9] : ARRAY OF CHAR )
  343.   : LONGINT;
  344. PROCEDURE ExpungeXRef* [base,-132] ();
  345. PROCEDURE AddAmigaGuideHostA* [base,-138]
  346.   ( h     [8] : u.HookBasePtr;
  347.     name  [0] : ARRAY OF CHAR;
  348.     attrs [9] : ARRAY OF u.TagItem )
  349.   : AmigaGuideHostPtr;
  350. PROCEDURE AddAmigaGuideHost* [base,-138]
  351.   ( h     [8]  : u.HookBasePtr;
  352.     name  [0]  : ARRAY OF CHAR;
  353.     attrs [9]..: u.Tag )
  354.   : AmigaGuideHostPtr;
  355. PROCEDURE RemoveAmigaGuideHostA* [base,-144]
  356.   ( hh    [8] : AmigaGuideHostPtr;
  357.     attrs [9] : ARRAY OF u.TagItem )
  358.   : LONGINT;
  359. PROCEDURE RemoveAmigaGuideHost* [base,-144]
  360.   ( hh    [8]  : AmigaGuideHostPtr;
  361.     attrs [9]..: u.Tag )
  362.   : LONGINT;
  363. PROCEDURE GetAmigaGuideString* [base,-210]
  364.   ( id [0] : LONGINT )
  365.   : e.LSTRPTR;
  366.  
  367. (**-- Library Base variable --------------------------------------------*)
  368.  
  369. (**-----------------------------------*)
  370. PROCEDURE* [0] CloseLib (VAR rc : LONGINT);
  371.  
  372. BEGIN (* CloseLib *)
  373.   IF base # NIL THEN e.CloseLibrary (base) END
  374. END CloseLib;
  375.  
  376. BEGIN
  377.   base := e.OpenLibrary (amigaguideName, e.libraryMinimum);
  378.   IF base # NIL THEN Kernel.SetCleanup (CloseLib) END
  379. END AmigaGuide.
  380.